<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="managedkafka_v1.html">Managed Service for Apache Kafka API</a> . <a href="managedkafka_v1.projects.html">projects</a> . <a href="managedkafka_v1.projects.locations.html">locations</a> . <a href="managedkafka_v1.projects.locations.clusters.html">clusters</a> . <a href="managedkafka_v1.projects.locations.clusters.consumerGroups.html">consumerGroups</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a single consumer group.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the properties of a single consumer group.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the consumer groups in a given cluster.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the properties of a single consumer group.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
  <pre>Deletes a single consumer group.

Args:
  name: string, Required. The name of the consumer group to delete. `projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumerGroup}`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Returns the properties of a single consumer group.

Args:
  name: string, Required. The name of the consumer group whose configuration to return. `projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumerGroup}`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A Kafka consumer group in a given cluster.
  &quot;name&quot;: &quot;A String&quot;, # Identifier. The name of the consumer group. The `consumer_group` segment is used when connecting directly to the cluster. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumer_group}
  &quot;topics&quot;: { # Optional. Metadata for this consumer group for all topics it has metadata for. The key of the map is a topic name, structured like: projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}
    &quot;a_key&quot;: { # Metadata for a consumer group corresponding to a specific topic.
      &quot;partitions&quot;: { # Optional. Metadata for this consumer group and topic for all partition indexes it has metadata for.
        &quot;a_key&quot;: { # Metadata for a consumer group corresponding to a specific partition.
          &quot;metadata&quot;: &quot;A String&quot;, # Optional. The associated metadata for this partition, or empty if it does not exist.
          &quot;offset&quot;: &quot;A String&quot;, # Required. The current offset for this partition, or 0 if no offset has been committed.
        },
      },
    },
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists the consumer groups in a given cluster.

Args:
  parent: string, Required. The parent cluster whose consumer groups are to be listed. Structured like `projects/{project}/locations/{location}/clusters/{cluster}`. (required)
  pageSize: integer, Optional. The maximum number of consumer groups to return. The service may return fewer than this value. If unset or zero, all consumer groups for the parent is returned.
  pageToken: string, Optional. A page token, received from a previous `ListConsumerGroups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConsumerGroups` must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for ListConsumerGroups.
  &quot;consumerGroups&quot;: [ # The list of consumer group in the requested parent. The order of the consumer groups is unspecified.
    { # A Kafka consumer group in a given cluster.
      &quot;name&quot;: &quot;A String&quot;, # Identifier. The name of the consumer group. The `consumer_group` segment is used when connecting directly to the cluster. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumer_group}
      &quot;topics&quot;: { # Optional. Metadata for this consumer group for all topics it has metadata for. The key of the map is a topic name, structured like: projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}
        &quot;a_key&quot;: { # Metadata for a consumer group corresponding to a specific topic.
          &quot;partitions&quot;: { # Optional. Metadata for this consumer group and topic for all partition indexes it has metadata for.
            &quot;a_key&quot;: { # Metadata for a consumer group corresponding to a specific partition.
              &quot;metadata&quot;: &quot;A String&quot;, # Optional. The associated metadata for this partition, or empty if it does not exist.
              &quot;offset&quot;: &quot;A String&quot;, # Required. The current offset for this partition, or 0 if no offset has been committed.
            },
          },
        },
      },
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # A token that can be sent as `page_token` to retrieve the next page of results. If this field is omitted, there are no more results.
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
  <pre>Updates the properties of a single consumer group.

Args:
  name: string, Identifier. The name of the consumer group. The `consumer_group` segment is used when connecting directly to the cluster. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumer_group} (required)
  body: object, The request body.
    The object takes the form of:

{ # A Kafka consumer group in a given cluster.
  &quot;name&quot;: &quot;A String&quot;, # Identifier. The name of the consumer group. The `consumer_group` segment is used when connecting directly to the cluster. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumer_group}
  &quot;topics&quot;: { # Optional. Metadata for this consumer group for all topics it has metadata for. The key of the map is a topic name, structured like: projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}
    &quot;a_key&quot;: { # Metadata for a consumer group corresponding to a specific topic.
      &quot;partitions&quot;: { # Optional. Metadata for this consumer group and topic for all partition indexes it has metadata for.
        &quot;a_key&quot;: { # Metadata for a consumer group corresponding to a specific partition.
          &quot;metadata&quot;: &quot;A String&quot;, # Optional. The associated metadata for this partition, or empty if it does not exist.
          &quot;offset&quot;: &quot;A String&quot;, # Required. The current offset for this partition, or 0 if no offset has been committed.
        },
      },
    },
  },
}

  updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the ConsumerGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. The mask is required and a value of * will update all fields.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A Kafka consumer group in a given cluster.
  &quot;name&quot;: &quot;A String&quot;, # Identifier. The name of the consumer group. The `consumer_group` segment is used when connecting directly to the cluster. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumer_group}
  &quot;topics&quot;: { # Optional. Metadata for this consumer group for all topics it has metadata for. The key of the map is a topic name, structured like: projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}
    &quot;a_key&quot;: { # Metadata for a consumer group corresponding to a specific topic.
      &quot;partitions&quot;: { # Optional. Metadata for this consumer group and topic for all partition indexes it has metadata for.
        &quot;a_key&quot;: { # Metadata for a consumer group corresponding to a specific partition.
          &quot;metadata&quot;: &quot;A String&quot;, # Optional. The associated metadata for this partition, or empty if it does not exist.
          &quot;offset&quot;: &quot;A String&quot;, # Required. The current offset for this partition, or 0 if no offset has been committed.
        },
      },
    },
  },
}</pre>
</div>

</body></html>